SpringBoot 参数校验的方法

2023-12-05 07:08| 来源: 网络整理| 查看: 265

Introduction

有参数传递的地方都少不了参数校验。在web开发中，前端的参数校验是为了用户体验，后端的参数校验是为了安全。试想一下，如果在controller层中没有经过任何校验的参数通过service层、dao层一路来到了数据库就可能导致严重的后果，最好的结果是查不出数据，严重一点就是报错，如果这些没有被校验的参数中包含了恶意代码，那就可能导致更严重的后果。

这里我们主要介绍在springboot中的几种参数校验方式。常用的用于参数校验的注解如下：

@AssertFalse 所注解的元素必须是Boolean类型，且值为false @AssertTrue 所注解的元素必须是Boolean类型，且值为true @DecimalMax 所注解的元素必须是数字，且值小于等于给定的值 @DecimalMin 所注解的元素必须是数字，且值大于等于给定的值 @Digits 所注解的元素必须是数字，且值必须是指定的位数 @Future 所注解的元素必须是将来某个日期 @Max 所注解的元素必须是数字，且值小于等于给定的值 @Min 所注解的元素必须是数字，且值小于等于给定的值 @Range 所注解的元素需在指定范围区间内 @NotNull 所注解的元素值不能为null @NotBlank 所注解的元素值有内容 @Null 所注解的元素值为null @Past 所注解的元素必须是某个过去的日期 @PastOrPresent 所注解的元素必须是过去某个或现在日期 @Pattern 所注解的元素必须满足给定的正则表达式 @Size 所注解的元素必须是String、集合或数组，且长度大小需保证在给定范围之内 @Email 所注解的元素需满足Email格式 controller层参数校验

在controller层的参数校验可以分为两种场景：

单个参数校验实体类参数校验单个参数校验 @RestController @Validated public class PingController { @GetMapping("/getUser") public String getUserStr(@NotNull(message = "name 不能为空") String name, @Max(value = 99, message = "不能大于99岁") Integer age) { return "name: " + name + " ,age:" + age; } }

当处理GET请求时或只传入少量参数的时候，我们可能不会建一个bean来接收这些参数，就可以像上面这样直接在controller方法的参数中进行校验。

注意：这里一定要在方法所在的controller类上加入@Validated注解，不然没有任何效果。

这时候在postman输入请求：

http://localhost:8080/getUser?name=Allan&age=101

调用方会收到springboot默认的格式报错：

{ "timestamp": "2019-06-01T04:30:26.882+0000", "status": 500, "error": "Internal Server Error", "message": "getUserStr.age: 不能大于99岁", "path": "/getUser" }

后台会打印如下错误：

javax.validation.ConstraintViolationException: getUserStr.age: 不能大于99岁 at org.springframework.validation.beanvalidation.MethodValidationInterceptor.invoke(MethodValidationInterceptor.java:116) at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:185) at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:688) at io.shopee.bigdata.penalty.server.controller.PingController$$EnhancerBySpringCGLIB$$232cfd51.getUserStr() ...

如果有很多使用这种参数验证的controller方法，我们希望在一个地方对ConstraintViolationException异常进行统一处理，可以使用统一异常捕获，这需要借助@ControllerAdvice注解来实现，当然在springboot中我们就用@RestControllerAdvice（内部包含@ControllerAdvice和@ResponseBody的特性）

import org.springframework.http.HttpStatus; import org.springframework.web.bind.annotation.*; import javax.validation.ConstraintViolation; import javax.validation.ConstraintViolationException; import javax.validation.ValidationException; import java.util.Set; /** * @author pengchengbai * @date 2019-06-01 14:09 */ @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(ValidationException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public String handle(ValidationException exception) { if(exception instanceof ConstraintViolationException){ ConstraintViolationException exs = (ConstraintViolationException) exception; Set[] groups() default {}; Class

【本文地址】

公司简介

联系我们